ドキュメンテーション基盤を最小化方式へ移行 - #196
Merged
Merged
Conversation
E:/chore/template_repo のドキュメント最小化方式（不変記録/台帳/生きた文書の3分類 + 機械検証）を導入。既存の docs/dependency-debt.md・docs/known-risks.md は 台帳としてそのまま policy に登録し、スキーマは変更しない。
docs/assurance-audit-2026-06-22.md は日付付きの凍結記録なので docs/records/2026-06-22_assurance-audit.md へ命名を揃えて移動。 known-risks.md 側とファイル内の相互リンクをパスのみ追従（内容は変更しない）。
composer run docs（composer run all にも追加）で node tools/docs-lint.mjs を 実行できるようにし、CLAUDE.md に docs/README.md の規約への参照を追記。
- docs-lint.yml の push トリガーに branches フィルタを追加し、既存 main.yml の 慣習（push: master、pull_request: master/develop）に合わせて PR ブランチでの push/pull_request 二重実行を防止 - CLAUDE.md の `composer run all` コメントに docs-lint を明記し、 composer run docs が Node.js を要求することを注記
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
E:\chore\template_repo のドキュメンテーション基盤テンプレート（不変記録/台帳/生きた文書の3分類 +
docs-lintによる機械検証）を適用した。simutrans-portal での実践（PR #561）を踏襲。tools/docs-lint.mjs/tools/docs-policy.jsonを導入し、既存ドキュメント（README.md/CLAUDE.md/docs/README.md）を livingDocs として登録して green 化。docs/dependency-debt.md・docs/known-risks.mdは台帳としてそのままledgersに登録（スキーマは無変更）。CI（.github/workflows/docs-lint.yml）を追加。temp/spec/knowledge等の旧分類ディレクトリは元々存在しなかった）。docs/assurance-audit-2026-06-22.md（凍結済みの初回 Assurance Audit 記録）を命名規則に合わせてdocs/records/2026-06-22_assurance-audit.mdへ移動し、known-risks.md側および記録内の相互参照リンクをパスのみ追従（内容は無変更）。composer run docs（composer run allにも追加）でnode tools/docs-lint.mjsを実行できるよう接続し、CLAUDE.mdにdocs/README.mdの規約への参照を追記。発見事項
このリポジトリはもともとドキュメント量が少なく（3ファイルのみ）、旧5分類（spec/manual/knowledge/log/temp）や手動索引の残骸は存在しなかった。simutrans-portal で見つかったような「実装と内容が一致しない架空文書」も見つかっていない。
docs/known-risks.mdは解消しても行を削除せず Status/テスト欄を更新する独自運用（dependency-debt.mdの delete-on-resolve とは異なる）だったため、そのままの運用を尊重してledgersに登録した。.github/copilot-instructions.mdは docs/ 配下へのファイルパス参照を含んでいなかったため、修正不要だった（確認済み）。Test plan
node tools/docs-lint.mjs（composer run docs）が 0 error / 0 warningcomposer run docsが単体で実行できることを確認docs-lint.ymlワークフロー）が green になることを確認🤖 Generated with Claude Code